Skip to content

CCIP overview card #2244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

CCIP overview card #2244

wants to merge 5 commits into from

Conversation

aelmanaa
Copy link
Collaborator

@aelmanaa aelmanaa commented Jan 9, 2025

This pull request introduces a new, extensible role-based navigation system for the CCIP product, including a structured configuration for product roles, type definitions, and reusable UI components for role cards. It also refactors several CCIP-related pages to streamline frontmatter and heading management, and updates icon handling for role cards.

Role-based navigation and configuration:

  • Introduced a new ccipRoles configuration object in src/config/roles/ccip.ts, defining roles, descriptions, icons, and categorized links for the CCIP product. This enables a scalable, role-driven navigation and documentation experience.
  • Added type definitions for roles, links, and product roles in src/config/roles/types.ts to ensure type safety and maintainability.
  • Created a central registry for product role configurations in src/config/roles/getRolesByProduct.ts, currently supporting CCIP and ready for future products.

Role card UI components and styling:

  • Added a generic, reusable RoleCardGeneric React component in src/features/landing/components/RoleCardGeneric.tsx to display role information and grouped links, utilizing a new icon map from src/assets/role-icons/index.ts. [1] [2]
  • Implemented new CSS modules for role card layouts and styling: RoleCards.module.css and RoleCardsGeneric.module.css, providing responsive and accessible design for the role cards grid. [1] [2]

CCIP page frontmatter and heading refactor:

  • Refactored Chain.astro, Token.astro, and ccip-landing.astro to define frontmatter and headings directly in each file, removing dependency on getEntry and simplifying data flow to layouts. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Content and sidebar updates:

  • Renamed src/content/ccip/index.mdx to about.mdx and updated its frontmatter for improved metadata and description.
  • Added an "About CCIP" entry to the sidebar configuration for improved discoverability.

Copy link

vercel bot commented Jan 9, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Jan 9, 2025 3:40pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant